CopyToWritableDirectoryContents(IDirectoryContents2,IWritableDirectoryContents,Boolean,Int32,IProgress<String[]>) Method

Copies the directory into another writable directory contents, optionally recursively, specifying copy buffer size, and a progress update provider.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function CopyToWritableDirectoryContents( _
   ByVal directoryContents2 As IDirectoryContents2, _
   ByVal destinationWritableDirectoryContents As IWritableDirectoryContents, _
   ByVal recursive As Boolean, _
   ByVal copyBufferSize As Integer, _
   ByVal stringArrayProgress As IProgress(Of String()) _
) As ValueTuple(Of Long,Long,Long)

'Usage
 
Dim directoryContents2 As IDirectoryContents2
Dim destinationWritableDirectoryContents As IWritableDirectoryContents
Dim recursive As Boolean
Dim copyBufferSize As Integer
Dim stringArrayProgress As IProgress(Of String())
Dim value As ValueTuple(Of Long,Long,Long)
 
value = IDirectoryContents2Extension.CopyToWritableDirectoryContents(directoryContents2, destinationWritableDirectoryContents, recursive, copyBufferSize, stringArrayProgress)

[Extension()]
public static ValueTuple<long,long,long> CopyToWritableDirectoryContents( 
   IDirectoryContents2 directoryContents2,
   IWritableDirectoryContents destinationWritableDirectoryContents,
   bool recursive,
   int copyBufferSize,
   IProgress<string[]> stringArrayProgress
)

[Extension()]
public:
static ValueTuple<int64,int64,int64> CopyToWritableDirectoryContents( 
   IDirectoryContents2^ directoryContents2,
   IWritableDirectoryContents^ destinationWritableDirectoryContents,
   bool recursive,
   int copyBufferSize,
   IProgress<array<String^>>^ stringArrayProgress
)

Parameters

directoryContents2: The directory contents object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
destinationWritableDirectoryContents: The writable directory contents into which the directory will be copied.
The value of this parameter cannot be null (Nothing in Visual Basic).
recursive: Determines whether operation will also be performed on subdirectories, recursively.
copyBufferSize: The size of the copy buffer. This value must be greater than zero. The default size is 81920.
Valid values of this parameter are in the range from 1 to 2147483647 (Int32.MaxValue).
stringArrayProgress: A provider for progress updates (string arrays).
The value of this parameter can be null (Nothing in Visual Basic).

Return Value

Returns a tuple with number of bytes copied, number of files copied, and number of directories copied.

Exceptions

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.IO.DirectoryNotFoundException	Part of a file or directory cannot be found. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.FileNotFoundException	An attempt to access a file that does not exist on disk has failed. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.IO.PathTooLongException	A path or fully qualified file name is longer than the system-defined maximum length. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IDirectoryContents2Extension Class
IDirectoryContents2Extension Members
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.